Docs For Class SendMail

Description

Ein einfaches Interface zum Versenden von Emails über das eStudy-Portal.

Diese Klasse wickelt das gesammte Mail-Versenden eingenständig und automatisch ab. Einfach die Methode SendMail::doit()doit() aufrufen, und los geht's.
Allerdings muß auf die Verwendung von POST und GET Variablen geachtet werden. Sind die beiden Variablen to und callingScript gesetzt, erfolgt ein unterschiedliches Verhalten.
to ist eine UserID, die angibt, das nur an diesen Portalbenutzer eine Email versendet wird.
callingScript gibt an, auf welches Skript nach dem Versenden der Email weiter verzweigt werden soll. Außerdem wird ein Zurück-Link erzeugt, das ebenfalls auf dieses Skript verweist.

author: Christian Gerhardt <case42@gmx.net>
version: 0.9, 01/04/04

Located in /communication/classes/class.sendmail.inc.php (line 66)

Method Summary

SendMail SendMail ([integer $course = 0], [integer $user = 0])

integer checkData ()

void doit ()

void echoBackLink (string $name, [bool $asButton = false])

void echoErrorMessage (integer $errorCode)

void echoForm ()

void echoMailForm ([integer $to = 0])

array echoUserList ()

bool send ()

void unsetPost ()

Methods

Constructor SendMail (line 101)

Konstruktor

access: public

SendMail SendMail ([integer $course = 0], [integer $user = 0])

integer $course
integer $user

checkData (line 335)

Prüft ob alle Eingaben zum Versenden der Email gemacht wurden.

return: Errorcode (0 = alles klar)
access: protected

integer checkData ()

doit (line 128)

Methode welche die Funtion der Klasse in Gang setzt.

Es wird je nach Einstellungen und den per POST oder GET Werten ein Eingabe-Formular für die Email und eine Liste zum Auswählen der Addressaten ausgegeben. Nachdem der User seine Angaben vollständig und richtig gemacht hat, wird die Email verschickt, und entweder auf das aufrufenden Skript zurück verwiesen, oder das Formular erneut ausgegeben.

access: public

void doit ()

echoBackLink (line 414)

Gibt den Link zu SendMail::$callingScript aus.

Es wird keine Ausgabe gemacht, falls SendMail::$callingScript gelich NULL ist.

access: protected

void echoBackLink (string $name, [bool $asButton = false])

string $name: - der Name den der Link haben soll
bool $asButton: - ob der Link als Button ausgegeben werden soll.

echoErrorMessage (line 358)

Gibt die Fehlermeldungen zu den Fehlern aus, die checkData() gefunden hat.

Falls $errorCode = 0, wird keine Ausgabe gemacht.

access: protected

void echoErrorMessage (integer $errorCode)

integer $errorCode: - der Errorcode der ausgegeben werden soll.

echoForm (line 252)

Diese Methode regelt, welche Ausgaben an den Brower gemacht werden müssen, um die gewünschte Funktionalität zu erhalten.

Es wird die Formatierung geregelt, und die Funktionen : echoMailForm und echoUserList() werden von hieraus aufgerufen.

access: protected

void echoForm ()

echoMailForm (line 292)

Funktion zum Ausgeben eines Mail-Versand-Formulars.

access: protected

void echoMailForm ([integer $to = 0])

integer $to: - Empfänger

echoUserList (line 157)

Gibt die Benutzerliste des Portals oder des Kurses aus, damit daraus einer oder mehrere Adressaten ausgewählt werden können.

return: - Liste von userIDs, die ausgewählt wurden, oder NULL
access: protected

array echoUserList ()

send (line 386)

Versendet die Email, mit den in $_POST übergebenen Daten.

Die Daten in $_POST müssen vorher unbedingt auf Richtigkeit überprüft worden sein!

return: - erfolgswert
access: protected

bool send ()

unsetPost (line 401)

Löscht die von der Klasse benutzten Werte aus der $_POST Variablen.

access: protected

void unsetPost ()